blocktrail / blocktrail-sdk-nodejs

 * jsPDF - PDF Document creation from JavaScript

 * Version 1.0.0-trunk Built on ${buildDate}

 * Commit ${commitID}

 *

 * Copyright (c) 2010-2014 James Hall, https://github.com/MrRio/jsPDF

 *               2010 Aaron Spike, https://github.com/acspike

 *               2012 Willow Systems Corporation, willow-systems.com

 *               2012 Pablo Hess, https://github.com/pablohess

 *               2012 Florian Jenett, https://github.com/fjenett

 *               2013 Warren Weckesser, https://github.com/warrenweckesser

 *               2013 Youssef Beddad, https://github.com/lifof

 *               2013 Lee Driscoll, https://github.com/lsdriscoll

 *               2013 Stefan Slonevskiy, https://github.com/stefslon

 *               2013 Jeremy Morel, https://github.com/jmorel

 *               2013 Christoph Hartmann, https://github.com/chris-rock

 *               2014 Juan Pablo Gaviria, https://github.com/juanpgaviria

 *               2014 James Makes, https://github.com/dollaruw

 *               2014 Diego Casorran, https://github.com/diegocr

 *

 * Permission is hereby granted, free of charge, to any person obtaining

 * a copy of this software and associated documentation files (the

 * "Software"), to deal in the Software without restriction, including

 * without limitation the rights to use, copy, modify, merge, publish,

 * distribute, sublicense, and/or sell copies of the Software, and to

 * permit persons to whom the Software is furnished to do so, subject to

 * the following conditions:

 *

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 * 

 * Contributor(s):

 *    siefkenj, ahwolf, rickygu, Midnith, saintclair, eaparango,

 *    kim3er, mfo, alnorth, 

 */

/**

Creates new jsPDF document object instance

@class

@param orientation One of "portrait" or "landscape" (or shortcuts "p" (Default), "l")

@param unit Measurement unit to be used when coordinates are specified. One of "pt" (points), "mm" (Default), "cm", "in"

@param format One of 'a0', 'a1', 'a2', 'a3', 'a4' (Default) etc to 'a10', 'b0' to 'b10', 'c0' to 'c10', 'letter', 'government-letter', 'legal', 'junior-legal', 'ledger' or 'tabloid'

@returns {jsPDF}

@name jsPDF

*/

var jsPDF = (function (global) {

    'use strict';

    /*jslint browser:true, plusplus: true, bitwise: true, nomen: true */

    /*global document: false, btoa, atob, zpipe, Uint8Array, ArrayBuffer, Blob, saveAs, adler32cs, Deflater */

// this will run on <=IE9, possibly some niche browsers

// new webkit-based, FireFox, IE10 already have native version of this.

    if (typeof btoa === 'undefined') {

        global.btoa = function (data) {

        // DO NOT ADD UTF8 ENCODING CODE HERE!!!!

        // UTF8 encoding encodes bytes over char code 128

        // and, essentially, turns an 8-bit binary streams

        // (that base64 can deal with) into 7-bit binary streams.

        // (by default server does not know that and does not recode the data back to 8bit)

        // You destroy your data.

        // binary streams like jpeg image data etc, while stored in JavaScript strings,

        // (which are 16bit arrays) are in 8bit format already.

        // You do NOT need to char-encode that before base64 encoding.

        // if you, by act of fate

        // have string which has individual characters with code

        // above 255 (pure unicode chars), encode that BEFORE you base64 here.

        // you can use absolutely any approch there, as long as in the end,

        // base64 gets an 8bit (char codes 0 - 255) stream.

        // when you get it on the server after un-base64, you must

        // UNencode it too, to get back to 16, 32bit or whatever original bin stream.

        // Note, Yes, JavaScript strings are, in most cases UCS-2 -

        // 16-bit character arrays. This does not mean, however,

        // that you always have to UTF8 it before base64.

        // it means that if you have actual characters anywhere in

        // that string that have char code above 255, you need to

        // recode *entire* string from 16-bit (or 32bit) to 8-bit array.

        // You can do binary split to UTF16 (BE or LE)

        // you can do utf8, you can split the thing by hand and prepend BOM to it,

        // but whatever you do, make sure you mirror the opposite on

        // the server. If server does not expect to post-process un-base64

        // 8-bit binary stream, think very very hard about messing around with encoding.

        // so, long story short:

        // DO NOT ADD UTF8 ENCODING CODE HERE!!!!

        /* @preserve

        ====================================================================

        base64 encoder

        MIT, GPL

        version: 1109.2015

        discuss at: http://phpjs.org/functions/base64_encode

        +   original by: Tyler Akins (http://rumkin.com)

        +   improved by: Bayron Guevara

        +   improved by: Thunder.m

        +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)

        +   bugfixed by: Pellentesque Malesuada

        +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)

        +   improved by: Rafal Kukawski (http://kukawski.pl)

        +                Daniel Dotsenko, Willow Systems Corp, willow-systems.com

        ====================================================================

        */

            var b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=",

                b64a = b64.split(''),

                o1,

                o2,

                o3,

                h1,

                h2,

                h3,

                h4,

                bits,

                i = 0,

                ac = 0,

                enc = "",

                tmp_arr = [],

                r;

            do { // pack three octets into four hexets

                o1 = data.charCodeAt(i++);

                o2 = data.charCodeAt(i++);

                o3 = data.charCodeAt(i++);

                bits = o1 << 16 | o2 << 8 | o3;

                h1 = bits >> 18 & 0x3f;

                h2 = bits >> 12 & 0x3f;

                h3 = bits >> 6 & 0x3f;

                h4 = bits & 0x3f;

                // use hexets to index into b64, and append result to encoded string

                tmp_arr[ac++] = b64a[h1] + b64a[h2] + b64a[h3] + b64a[h4];

            } while (i < data.length);

            enc = tmp_arr.join('');

            r = data.length % 3;

            return (r ? enc.slice(0, r - 3) : enc) + '==='.slice(r || 3);

            // end of base64 encoder MIT, GPL

        };

    }

    if (typeof atob === 'undefined') {

        global.atob = function (data) {

        // http://kevin.vanzonneveld.net

        // +   original by: Tyler Akins (http://rumkin.com)

        // +   improved by: Thunder.m

        // +      input by: Aman Gupta

        // +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)

        // +   bugfixed by: Onno Marsman

        // +   bugfixed by: Pellentesque Malesuada

        // +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)

        // +      input by: Brett Zamir (http://brett-zamir.me)

        // +   bugfixed by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)

        // *     example 1: base64_decode('S2V2aW4gdmFuIFpvbm5ldmVsZA==');

        // *     returns 1: 'Kevin van Zonneveld'

        // mozilla has this native

        // - but breaks in 2.0.0.12!

        //if (typeof this.global['atob'] == 'function') {

        //    return atob(data);

        //}

            var b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=",

                o1,

                o2,

                o3,

                h1,

                h2,

                h3,

                h4,

                bits,

                i = 0,

                ac = 0,

                dec = "",

                tmp_arr = [];

            if (!data) {

                return data;

            }

            data += '';

            do { // unpack four hexets into three octets using index points in b64

                h1 = b64.indexOf(data.charAt(i++));

                h2 = b64.indexOf(data.charAt(i++));

                h3 = b64.indexOf(data.charAt(i++));

                h4 = b64.indexOf(data.charAt(i++));

                bits = h1 << 18 | h2 << 12 | h3 << 6 | h4;

                o1 = bits >> 16 & 0xff;

                o2 = bits >> 8 & 0xff;

                o3 = bits & 0xff;

                if (h3 === 64) {

                    tmp_arr[ac++] = String.fromCharCode(o1);

                } else if (h4 === 64) {

                    tmp_arr[ac++] = String.fromCharCode(o1, o2);

                } else {

                    tmp_arr[ac++] = String.fromCharCode(o1, o2, o3);

                }

            } while (i < data.length);

            dec = tmp_arr.join('');

            return dec;

        };

    }

    var getObjectLength = typeof Object.keys === 'function' ?

                function (object) {

                    return Object.keys(object).length;

                } :

                function (object) {

                    var i = 0, e;

                    for (e in object) {

                        if (object.hasOwnProperty(e)) {

                            i++;

                        }

                    }

                    return i;

                };

/**

PubSub implementation

@class

@name PubSub

*/

        global.PubSub = function (context) {

            /**  @preserve

            -----------------------------------------------------------------------------------------------

            JavaScript PubSub library

            2012 (c) [email protected]

            based on Peter Higgins ([email protected])

            Loosely based on Dojo publish/subscribe API, limited in scope. Rewritten blindly.

            Original is (c) Dojo Foundation 2004-2010. Released under either AFL or new BSD, see:

            http://dojofoundation.org/license for more information.

            -----------------------------------------------------------------------------------------------

            */

            /**

            @private

            @fieldOf PubSub

            */

            this.topics = {};

            /**

            Stores what will be `this` within the callback functions.

            @private

            @fieldOf PubSub#

            */

            this.context = context;

            /**

            Allows caller to emit an event and pass arguments to event listeners.

            @public

            @function

            @param topic {String} Name of the channel on which to voice this event

            @param args Any number of arguments you want to pass to the listeners of this event.

            @methodOf PubSub#

            @name publish

            */

            this.publish = function (topic, args) {

                if (this.topics[topic]) {

                    var currentTopic = this.topics[topic],

                        toremove = [],

                        fn,

                        i,

                        l,

                        pair,

                        emptyFunc = function () {};

                    args = Array.prototype.slice.call(arguments, 1);

                    for (i = 0, l = currentTopic.length; i < l; i++) {

                        pair = currentTopic[i]; // this is a [function, once_flag] array

                        fn = pair[0];

                        if (pair[1]) { /* 'run once' flag set */

                            pair[0] = emptyFunc;

                            toremove.push(i);

                        }

                        fn.apply(this.context, args);

                    }

                    for (i = 0, l = toremove.length; i < l; i++) {

                        currentTopic.splice(toremove[i], 1);

                    }

                }

            };

            /**

            Allows listener code to subscribe to channel and be called when data is available

            @public

            @function

            @param topic {String} Name of the channel on which to voice this event

            @param callback {Function} Executable (function pointer) that will be ran when event is voiced on this channel.

            @param once {Boolean} (optional. False by default) Flag indicating if the function is to be triggered only once.

            @returns {Object} A token object that cen be used for unsubscribing.

            @methodOf PubSub#

            @name subscribe

            */

            this.subscribe = function (topic, callback, once) {

                if (!this.topics[topic]) {

                    this.topics[topic] = [[callback, once]];

                } else {

                    this.topics[topic].push([callback, once]);

                }

                return {

                    "topic": topic,

                    "callback": callback

                };

            };

            /**

            Allows listener code to unsubscribe from a channel

            @public

            @function

            @param token {Object} A token object that was returned by `subscribe` method

            @methodOf PubSub#

            @name unsubscribe

            */

            this.unsubscribe = function (token) {

                if (this.topics[token.topic]) {

                    var currentTopic = this.topics[token.topic], i, l;

                    for (i = 0, l = currentTopic.length; i < l; i++) {

                        if (currentTopic[i][0] === token.callback) {

                            currentTopic.splice(i, 1);

                        }

                    }

                }

            };

        };

/**

@constructor

@private

*/

    function jsPDF(orientation, unit, format, compressPdf) { /** String orientation, String unit, String format, Boolean compressed */

        var options = {};

        if (typeof orientation === 'object') {

            options = orientation;

            orientation = options.orientation;

            unit        = options.unit || unit;

            format      = options.format || format;

            compressPdf = options.compress || options.compressPdf || compressPdf;

        }

        // Default parameter values

        if (typeof orientation === 'undefined') {

            orientation = 'p';

        } else {

            orientation = orientation.toString().toLowerCase();

        }

        if (typeof unit === 'undefined') { unit = 'mm'; }

        if (typeof format === 'undefined') { format = 'a4'; }

        if (typeof compressPdf === 'undefined' && typeof zpipe === 'undefined') { compressPdf = false; }

        var format_as_string = format.toString().toLowerCase(),

            content = [],

            content_length = 0,

            compress = compressPdf,

            pdfVersion = '1.3', // PDF Version

            pageFormats = { // Size in pt of various paper formats

                'a0': [2383.94, 3370.39],

                'a1': [1683.78, 2383.94],

                'a2': [1190.55, 1683.78],

                'a3': [841.89,  1190.55],

                'a4': [595.28,  841.89],

                'a5': [419.53,  595.28],

                'a6': [297.64,  419.53],

                'a7': [209.76,  297.64],

                'a8': [147.4 ,  209.76],

                'a9': [104.88,  147.4],

                'a10': [73.7,  104.88],

                'b0': [2834.65, 4008.19],

                'b1': [2004.09, 2834.65],

                'b2': [1417.32, 2004.09],

                'b3': [1000.63, 1417.32],

                'b4': [708.66,  1000.63],

                'b5': [498.9,  708.66],

                'b6': [354.33,  498.9],

                'b7': [249.45,  354.33],

                'b8': [175.75,  249.45],

                'b9': [124.72,  175.75],

                'b10': [87.87,  124.72],

                'c0': [2599.37, 3676.54],

                'c1': [1836.85, 2599.37],

                'c2': [1298.27, 1836.85],

                'c3': [918.43,  1298.27],

                'c4': [649.13,  918.43],

                'c5': [459.21,  649.13],

                'c6': [323.15,  459.21],

                'c7': [229.61,  323.15],

                'c8': [161.57,  229.61],

                'c9': [113.39,  161.57],

                'c10': [79.37,   113.39],

                'letter': [612, 792],

                'government-letter': [576, 756],

                'legal': [612, 1008],

                'junior-legal': [576, 360],

                'ledger': [1224, 792],

                'tabloid': [792, 1224]

            },

            textColor = options.textColor || '0 g',

            drawColor = options.drawColor || '0 G',

            page = 0,

            pages = [],

            objectNumber = 2, // 'n' Current object number

            outToPages = !!options.outToPages, // switches where out() prints. outToPages true = push to pages obj. outToPages false = doc builder content

            offsets = [], // List of offsets. Activated and reset by buildDocument(). Pupulated by various calls buildDocument makes.

            fonts = {}, // collection of font objects, where key is fontKey - a dynamically created label for a given font.

            fontmap = {}, // mapping structure fontName > fontStyle > font key - performance layer. See addFont()

            activeFontSize = options.fontSize || 16,

            activeFontKey, // will be string representing the KEY of the font as combination of fontName + fontStyle

            lineWidth = options.lineWidth || 0.200025, // 2mm

            lineHeightProportion = options.lineHeight || 1.15,

            pageHeight,

            pageWidth,

            k, // Scale factor

            documentProperties = {'title': '', 'subject': '', 'author': '', 'keywords': '', 'creator': ''},

            lineCapID = 0,

            lineJoinID = 0,

            API = {},

            tmp,

            plugin,

            /////////////////////

            // Private functions

            /////////////////////

            // simplified (speedier) replacement for sprintf's %.2f conversion

            f2 = function (number) {

                return number.toFixed(2);

            },

            // simplified (speedier) replacement for sprintf's %.3f conversion

            f3 = function (number) {

                return number.toFixed(3);

            },

            // simplified (speedier) replacement for sprintf's %02d

            padd2 = function (number) {

                var n = (number).toFixed(0);

                if (number < 10) {

                    return '0' + n;

                } else {

                    return n;

                }

            },

            // simplified (speedier) replacement for sprintf's %02d

            padd10 = function (number) {

                var n = (number).toFixed(0);

                if (n.length < 10) {

                    return new Array( 11 - n.length ).join('0') + n;

                } else {

                    return n;

                }

            },

            out = function (string) {

                if (outToPages) { /* set by beginPage */

                    pages[page].push(string);

                } else {

                    content.push(string);

                    content_length += string.length + 1; // +1 is for '\n' that will be used to join contents of content

                }

            },

            newObject = function () {

                // Begin a new object

                objectNumber++;

                offsets[objectNumber] = content_length;

                out(objectNumber + ' 0 obj');

                return objectNumber;

            },

            putStream = function (str) {

                out('stream');

                out(str);

                out('endstream');

            },

            wPt,

            hPt,

            kids,

            putPages = function () {

                wPt = pageWidth * k;

                hPt = pageHeight * k;

                // outToPages = false as set in endDocument(). out() writes to content.

                for (n = 1; n <= page; n++) {

                    newObject();

                    out('<</Type /Page');

                    out('/Parent 1 0 R');

                    out('/Resources 2 0 R');

                    out('/Contents ' + (objectNumber + 1) + ' 0 R>>');

                    out('endobj');

                    // Page content

                    p = pages[n].join('\n');

                    newObject();

                    if (compress) {

                        arr = [];

                        for (i = 0; i < p.length; ++i) {

                            arr[i] = p.charCodeAt(i);

                        }

                        adler32 = adler32cs.from(p);

                        deflater = new Deflater(6);

                        deflater.append(new Uint8Array(arr));

                        p = deflater.flush();

                        arr = [new Uint8Array([120, 156]), new Uint8Array(p),

                               new Uint8Array([adler32 & 0xFF, (adler32 >> 8) & 0xFF, (adler32 >> 16) & 0xFF, (adler32 >> 24) & 0xFF])];

                        p = '';

                        for (i in arr) {

                            if (arr.hasOwnProperty(i)) {

                                p += String.fromCharCode.apply(null, arr[i]);

                            }

                        }

                        out('<</Length ' + p.length  + ' /Filter [/FlateDecode]>>');

                    } else {

                        out('<</Length ' + p.length  + '>>');

                    }

                    putStream(p);

                    out('endobj');

                }

                offsets[1] = content_length;

                out('1 0 obj');

                out('<</Type /Pages');

                kids = '/Kids [';

                for (i = 0; i < page; i++) {

                }

                out(kids + ']');

                out('/Count ' + page);

                out('/MediaBox [0 0 ' + f2(wPt) + ' ' + f2(hPt) + ']');

                out('>>');

                out('endobj');

            },

            putFont = function (font) {

                font.objectNumber = newObject();

                out('<</BaseFont/' + font.PostScriptName + '/Type/Font');

                if (typeof font.encoding === 'string') {

                    out('/Encoding/' + font.encoding);

                }

                out('/Subtype/Type1>>');

                out('endobj');

            },

            putFonts = function () {

                var fontKey;

                for (fontKey in fonts) {

                    if (fonts.hasOwnProperty(fontKey)) {

                        putFont(fonts[fontKey]);

                    }

                }

            },

            putXobjectDict = function () {

                // Loop through images, or other data objects

                events.publish('putXobjectDict');

            },

            putResourceDictionary = function () {

                out('/ProcSet [/PDF /Text /ImageB /ImageC /ImageI]');

                out('/Font <<');

                // Do this for each font, the '1' bit is the index of the font

                var fontKey;

                for (fontKey in fonts) {

                    if (fonts.hasOwnProperty(fontKey)) {

                        out('/' + fontKey + ' ' + fonts[fontKey].objectNumber + ' 0 R');

                    }

                }

                out('>>');

                out('/XObject <<');

                putXobjectDict();

                out('>>');

            },

            putResources = function () {

                putFonts();

                events.publish('putResources');

                // Resource dictionary

                offsets[2] = content_length;

                out('2 0 obj');

                out('<<');

                putResourceDictionary();

                out('>>');

                out('endobj');

                events.publish('postPutResources');

            },

            addToFontDictionary = function (fontKey, fontName, fontStyle) {

                // this is mapping structure for quick font key lookup.

                // returns the KEY of the font (ex: "F1") for a given pair of font name and type (ex: "Arial". "Italic")

                var undef;

                    fontmap[fontName] = {}; // fontStyle is a var interpreted and converted to appropriate string. don't wrap in quotes.

                }

                fontmap[fontName][fontStyle] = fontKey;

            },

            /**

            FontObject describes a particular font as member of an instnace of jsPDF

            It's a collection of properties like 'id' (to be used in PDF stream),

            'fontName' (font's family name), 'fontStyle' (font's style variant label)

            @class

            @public

            @property id {String} PDF-document-instance-specific label assinged to the font.

            @property PostScriptName {String} PDF specification full name for the font

            @property encoding {Object} Encoding_name-to-Font_metrics_object mapping.

            @name FontObject

            */

            addFont = function (PostScriptName, fontName, fontStyle, encoding) {

                var fontKey = 'F' + (getObjectLength(fonts) + 1).toString(10),

                    // This is FontObject

                    font = fonts[fontKey] = {

                        'id': fontKey,

                        // , 'objectNumber':   will be set by putFont()

                        'PostScriptName': PostScriptName,

                        'fontName': fontName,

                        'fontStyle': fontStyle,

                        'encoding': encoding,

                        'metadata': {}

                    };

                addToFontDictionary(fontKey, fontName, fontStyle);

                events.publish('addFont', font);

                return fontKey;

            },

            addFonts = function () {

                var HELVETICA = "helvetica",

                    TIMES = "times",

                    COURIER = "courier",

                    NORMAL = "normal",

                    BOLD = "bold",

                    ITALIC = "italic",

                    BOLD_ITALIC = "bolditalic",

                    encoding = 'StandardEncoding',

                    standardFonts = [

                        ['Helvetica', HELVETICA, NORMAL],

                        ['Helvetica-Bold', HELVETICA, BOLD],

                        ['Helvetica-Oblique', HELVETICA, ITALIC],

                        ['Helvetica-BoldOblique', HELVETICA, BOLD_ITALIC],

                        ['Courier', COURIER, NORMAL],

                        ['Courier-Bold', COURIER, BOLD],

                        ['Courier-Oblique', COURIER, ITALIC],

                        ['Courier-BoldOblique', COURIER, BOLD_ITALIC],

                        ['Times-Roman', TIMES, NORMAL],

                        ['Times-Bold', TIMES, BOLD],

                        ['Times-Italic', TIMES, ITALIC],

                        ['Times-BoldItalic', TIMES, BOLD_ITALIC]

                    ],

                    i,

                    l,

                    fontKey,

                    parts;

                for (i = 0, l = standardFonts.length; i < l; i++) {

                    fontKey = addFont(

                        standardFonts[i][0],

                        standardFonts[i][1],

                        standardFonts[i][2],

                        encoding

                    );

                    // adding aliases for standard fonts, this time matching the capitalization

                    parts = standardFonts[i][0].split('-');

                    addToFontDictionary(fontKey, parts[0], parts[1] || '');

                }

                events.publish('addFonts', {'fonts': fonts, 'dictionary': fontmap});

            },

            /**

            @public

            @function

            @param text {String}

            @param flags {Object} Encoding flags.

            @returns {String} Encoded string

            */

            to8bitStream = function (text, flags) {

                /* PDF 1.3 spec:

                "For text strings encoded in Unicode, the first two bytes must be 254 followed by

                255, representing the Unicode byte order marker, U+FEFF. (This sequence conflicts

                with the PDFDocEncoding character sequence thorn ydieresis, which is unlikely

                to be a meaningful beginning of a word or phrase.) The remainder of the

                string consists of Unicode character codes, according to the UTF-16 encoding

                specified in the Unicode standard, version 2.0. Commonly used Unicode values

                are represented as 2 bytes per character, with the high-order byte appearing first

                in the string."

                In other words, if there are chars in a string with char code above 255, we

                recode the string to UCS2 BE - string doubles in length and BOM is prepended.

                HOWEVER!

                Actual *content* (body) text (as opposed to strings used in document properties etc)

                does NOT expect BOM. There, it is treated as a literal GID (Glyph ID)

                Because of Adobe's focus on "you subset your fonts!" you are not supposed to have

                a font that maps directly Unicode (UCS2 / UTF16BE) code to font GID, but you could

                fudge it with "Identity-H" encoding and custom CIDtoGID map that mimics Unicode

                code page. There, however, all characters in the stream are treated as GIDs,

                including BOM, which is the reason we need to skip BOM in content text (i.e. that

                that is tied to a font).

                To signal this "special" PDFEscape / to8bitStream handling mode,

                API.text() function sets (unless you overwrite it with manual values

                given to API.text(.., flags) )

                    flags.autoencode = true

                    flags.noBOM = true

                */

                /*

                `flags` properties relied upon:

                .sourceEncoding = string with encoding label.

                    "Unicode" by default. = encoding of the incoming text.

                    pass some non-existing encoding name

                    (ex: 'Do not touch my strings! I know what I am doing.')

                    to make encoding code skip the encoding step.

                .outputEncoding = Either valid PDF encoding name

                    (must be supported by jsPDF font metrics, otherwise no encoding)

                    or a JS object, where key = sourceCharCode, value = outputCharCode

                    missing keys will be treated as: sourceCharCode === outputCharCode

                .noBOM

                    See comment higher above for explanation for why this is important

                .autoencode

                    See comment higher above for explanation for why this is important

                */

                var i, l, undef, sourceEncoding, encodingBlock, outputEncoding, newtext, isUnicode, ch, bch;

                    flags = {};

                }

                outputEncoding = flags.outputEncoding;

                // This 'encoding' section relies on font metrics format

                // attached to font objects by, among others,

                // "Willow Systems' standard_font_metrics plugin"

                // see jspdf.plugin.standard_font_metrics.js for format

                // of the font.metadata.encoding Object.

                // It should be something like

                //   .encoding = {'codePages':['WinANSI....'], 'WinANSI...':{code:code, ...}}

                //   .widths = {0:width, code:width, ..., 'fof':divisor}

                //   .kerning = {code:{previous_char_code:shift, ..., 'fof':-divisor},...}

                if ((flags.autoencode || outputEncoding) &&

                        fonts[activeFontKey].metadata &&

                        fonts[activeFontKey].metadata[sourceEncoding] &&

                        fonts[activeFontKey].metadata[sourceEncoding].encoding

                        ) {

                    encodingBlock = fonts[activeFontKey].metadata[sourceEncoding].encoding;

                    // each font has default encoding. Some have it clearly defined.

                    if (!outputEncoding && fonts[activeFontKey].encoding) {

                        outputEncoding = fonts[activeFontKey].encoding;

                    }

                    // Hmmm, the above did not work? Let's try again, in different place.

                    if (!outputEncoding && encodingBlock.codePages) {

                        outputEncoding = encodingBlock.codePages[0]; // let's say, first one is the default

                    }

                    if (typeof outputEncoding === 'string') {

                        outputEncoding = encodingBlock[outputEncoding];

                    }

                    // we want output encoding to be a JS Object, where

                    // key = sourceEncoding's character code and

                    // value = outputEncoding's character code.

                    if (outputEncoding) {

                        isUnicode = false;

                        newtext = [];

                        for (i = 0, l = text.length; i < l; i++) {

                            ch = outputEncoding[text.charCodeAt(i)];

                            if (ch) {

                                newtext.push(

                                    String.fromCharCode(ch)

                                );

                            } else {

                                newtext.push(

                                    text[i]

                                );

                            }

                            // since we are looping over chars anyway, might as well

                            // check for residual unicodeness

                            if (newtext[i].charCodeAt(0) >> 8) { /* more than 255 */

                                isUnicode = true;

                            }

                        }

                        text = newtext.join('');

                    }

                }

                i = text.length;

                // isUnicode may be set to false above. Hence the triple-equal to undefined

                    if (text.charCodeAt(i - 1) >> 8) { /* more than 255 */

                        isUnicode = true;

                    }

                    i--;

                }

                if (!isUnicode) {

                    return text;

                } else {

                    newtext = flags.noBOM ? [] : [254, 255];

                    for (i = 0, l = text.length; i < l; i++) {

                        ch = text.charCodeAt(i);

                        bch = ch >> 8; // divide by 256

                        if (bch >> 8) { /* something left after dividing by 256 second time */

                            throw new Error("Character at position " + i.toString(10) + " of string '" + text + "' exceeds 16bits. Cannot be encoded into UCS-2 BE");

                        }

                        newtext.push(bch);

                        newtext.push(ch - (bch << 8));

                    }

                    return String.fromCharCode.apply(undef, newtext);

                }

            },

            // Replace '/', '(', and ')' with pdf-safe versions

            pdfEscape = function (text, flags) {

                // doing to8bitStream does NOT make this PDF display unicode text. For that

                // we also need to reference a unicode font and embed it - royal pain in the rear.

                // There is still a benefit to to8bitStream - PDF simply cannot handle 16bit chars,

                // which JavaScript Strings are happy to provide. So, while we still cannot display

                // 2-byte characters property, at least CONDITIONALLY converting (entire string containing)

                // 16bit chars to (USC-2-BE) 2-bytes per char + BOM streams we ensure that entire PDF

                // is still parseable.

                // This will allow immediate support for unicode in document properties strings.

                return to8bitStream(text, flags).replace(/\\/g, '\\\\').replace(/\(/g, '\\(').replace(/\)/g, '\\)');

            },

            putInfo = function () {

                out('/Producer (jsPDF ' + jsPDF.version + ')');

                if (documentProperties.title) {

                    out('/Title (' + pdfEscape(documentProperties.title) + ')');

                }

                if (documentProperties.subject) {

                    out('/Subject (' + pdfEscape(documentProperties.subject) + ')');

                }

                if (documentProperties.author) {

                    out('/Author (' + pdfEscape(documentProperties.author) + ')');

                }

                if (documentProperties.keywords) {

                    out('/Keywords (' + pdfEscape(documentProperties.keywords) + ')');

                }

                if (documentProperties.creator) {

                    out('/Creator (' + pdfEscape(documentProperties.creator) + ')');

                }

                var created = new Date();

                out('/CreationDate (D:' +

                    [

                        created.getFullYear(),

                        padd2(created.getMonth() + 1),

                        padd2(created.getDate()),

                        padd2(created.getHours()),

                        padd2(created.getMinutes()),

                        padd2(created.getSeconds())

                    ].join('') +

                    ')'

                    );

            },

            putCatalog = function () {

                out('/Type /Catalog');

                out('/Pages 1 0 R');

                // @TODO: Add zoom and layout modes

                out('/OpenAction [3 0 R /FitH null]');

                out('/PageLayout /OneColumn');

                events.publish('putCatalog');

            },

            putTrailer = function () {

                out('/Size ' + (objectNumber + 1));

                out('/Root ' + objectNumber + ' 0 R');

                out('/Info ' + (objectNumber - 1) + ' 0 R');

            },

            beginPage = function () {

                page++;

                // Do dimension stuff

                outToPages = true;

                pages[page] = [];

            },

            _addPage = function () {

                beginPage();

                // Set line width

                out(f2(lineWidth * k) + ' w');

                // Set draw color

                out(drawColor);

                // resurrecting non-default line caps, joins

                if (lineCapID !== 0) {

                    out(lineCapID.toString(10) + ' J');

                }

                if (lineJoinID !== 0) {

                    out(lineJoinID.toString(10) + ' j');

                }

                events.publish('addPage', {'pageNumber': page});

            },

            /**

            Returns a document-specific font key - a label assigned to a

            font name + font type combination at the time the font was added

            to the font inventory.

            Font key is used as label for the desired font for a block of text

            to be added to the PDF document stream.

            @private

            @function

            @param fontName {String} can be undefined on "falthy" to indicate "use current"

            @param fontStyle {String} can be undefined on "falthy" to indicate "use current"

            @returns {String} Font key.

            */

            getFont = function (fontName, fontStyle) {

                var key, undef;

                    fontName = fonts[activeFontKey].fontName;

                }

                if (fontStyle === undef) {

                    fontStyle = fonts[activeFontKey].fontStyle;

                }

                try {

                    key = fontmap[fontName][fontStyle]; // returns a string like 'F3' - the KEY corresponding tot he font + type combination.

                } catch (e) {

                    key = undef;

                }

                if (!key) {

                    throw new Error("Unable to look up font label for font '" + fontName + "', '" + fontStyle + "'. Refer to getFontList() for available fonts.");

                }

                return key;

            },

            buildDocument = function () {

                outToPages = false; // switches out() to content

                objectNumber = 2;

                content = [];

                offsets = [];

                // putHeader()

                out('%PDF-' + pdfVersion);

                putPages();

                putResources();

                // Info

                newObject();

                out('<<');

                putInfo();

                out('>>');

                out('endobj');

                // Catalog

                newObject();

                out('<<');

                putCatalog();

                out('>>');

                out('endobj');

                // Cross-ref

                var o = content_length, i;

                out('xref');

                out('0 ' + (objectNumber + 1));

                out('0000000000 65535 f ');

                for (i = 1; i <= objectNumber; i++) {

                    out(padd10(offsets[i]) + ' 00000 n ');

                }

                // Trailer

                out('trailer');

                out('<<');

                putTrailer();

                out('>>');

                out('startxref');

                out(o);

                out('%%EOF');

                outToPages = true;

                return content.join('\n');

            },

            getStyle = function (style) {

                // see Path-Painting Operators of PDF spec

                var op = 'S'; // stroke

                if (style === 'F') {

                    op = 'f'; // fill

                } else if (style === 'FD' || style === 'DF') {

                    op = 'B'; // both

                }

                return op;

            },

            getBlob = function () {

                var data, length, array, i, blob;

                data = buildDocument();

                // Need to add the file to BlobBuilder as a Uint8Array

                length = data.length;

                array = new Uint8Array(new ArrayBuffer(length));

                for (i = 0; i < length; i++) {

                    array[i] = data.charCodeAt(i);

                }

                blob = new Blob([array], {type: "application/pdf"});

                return blob;

            },

            /**

            Generates the PDF document.

            Possible values:

                datauristring (alias dataurlstring) - Data-Url-formatted data returned as string.

                datauri (alias datauri) - Data-Url-formatted data pushed into current global's location (effectively reloading the global with contents of the PDF).

            If `type` argument is undefined, output is raw body of resulting PDF returned as a string.

            @param {String} type A string identifying one of the possible output types.

            @param {Object} options An object providing some additional signalling to PDF generator.

            @function

            @returns {jsPDF}

            @methodOf jsPDF#

            @name output

            */

            output = function (type, options) {

                switch (type) {

                    return buildDocument();

                case 'save':

                        if (global.URL === undefined) {

                            return API.output('dataurlnewwindow');

                        } else if (global.URL.createObjectURL === undefined) {

                            return API.output('dataurlnewwindow');

                        }

                    }

                    saveAs(getBlob(), options);